Class EMEAScriptEngineImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.EMEAScriptEngineImpl
All Implemented Interfaces:
IPCObject, EMEAScriptEngine
Direct Known Subclasses:
ActivityScriptEngineImpl

public class EMEAScriptEngineImpl extends IPCObjectImpl implements EMEAScriptEngine
Information provided by the PKI file:

    \class EMEAScriptEngine
    
    \brief EMEAScriptEngine gives access to Packet Tracer's Script Engine.
    
    \example appWindow().getActiveFile().getScriptEngine()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • evaluateFile

      public ScriptValue evaluateFile(String filepath)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param filepath, the filepath of the script of interest.
          
          \return ScriptValue, the ScriptValue object of the specified script.
          
              
      Specified by:
      evaluateFile in interface EMEAScriptEngine
      Parameters:
      filepath - Takes in a parameter of filepath
      Returns:
      ScriptValue Returns a ScriptValue
    • canEvaluate

      public boolean canEvaluate(String program)
      Information provided by the PKI file:
      
          \brief Returns true if the specified script can be evaluated, otherwise false.
          
          \param program, the code of the script of interest.
          
          \return bool, true if the specified script can be evaluated, otherwise false.
          
              
      Specified by:
      canEvaluate in interface EMEAScriptEngine
      Parameters:
      program - Takes in a parameter of program
      Returns:
      boolean Returns a boolean
    • globalObject

      public ScriptValue globalObject()
      Information provided by the PKI file:
      
          \brief Returns the global ScriptValue object.
          
          \return ScriptValue, the global ScriptValue object.
          
              
      Specified by:
      globalObject in interface EMEAScriptEngine
      Returns:
      ScriptValue Returns a ScriptValue
    • evaluate

      public ScriptValue evaluate(String program, String id)
      Information provided by the PKI file:
      
          \brief Evaluates the specified script.
          
          \param program, the code of the script of interest.
          \param id, the name of the script of interest.
          
          \return ScriptValue, the ScriptValue object of the specified script.
          
              
      Specified by:
      evaluate in interface EMEAScriptEngine
      Parameters:
      program - Takes in a parameter of program
      id - Takes in a parameter of id
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueInt

      public ScriptValue createScriptValueInt(int value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified integer value.
          
          \param value, the integer value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Specified by:
      createScriptValueInt in interface EMEAScriptEngine
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueBool

      public ScriptValue createScriptValueBool(boolean value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified boolean value.
          
          \param value, the boolean value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Specified by:
      createScriptValueBool in interface EMEAScriptEngine
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue
    • createScriptValueQString

      public ScriptValue createScriptValueQString(String value)
      Information provided by the PKI file:
      
          \brief Creates a ScriptValue object with the specified QString value.
          
          \param value, the QString value of the ScriptValue object.
          
          \return ScriptValue, the ScriptValue object.
          
              
      Specified by:
      createScriptValueQString in interface EMEAScriptEngine
      Parameters:
      value - Takes in a parameter of value
      Returns:
      ScriptValue Returns a ScriptValue